<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: session/shm/arena_lend/jemalloc/server_session.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_b574b0807182fd54d29cf48452072c45.html">session</a></li><li class="navelem"><a class="el" href="dir_df5b0ac3fc1820ebfc25c1160f1f4b3a.html">shm</a></li><li class="navelem"><a class="el" href="dir_d1a5353b5ceb9e8de9acee201f2ed2e4.html">arena_lend</a></li><li class="navelem"><a class="el" href="dir_d618e329fbb069400f9c6c11fc37efe1.html">jemalloc</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">server_session.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: SHM-jemalloc</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright (c) 2023 Akamai Technologies, Inc.; and other contributors.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> * Each commit is copyright by its respective author or author&#39;s employer.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * Licensed under the MIT License:</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> *</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> * in the Software without restriction, including without limitation the rights</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> *</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * The above copyright notice and this permission notice shall be included in</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * all copies or substantial portions of the Software.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> *</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment"> * THE SOFTWARE. */</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment"></span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#include &quot;<a class="code" href="session_2shm_2arena__lend_2jemalloc_2jemalloc_8hpp.html">ipc/session/shm/arena_lend/jemalloc/jemalloc.hpp</a>&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#include &quot;ipc/shm/arena_lend/jemalloc/jemalloc.hpp&quot;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__shm__arena__lend_2src_2ipc_2session_2detail_2shm_2arena__lend_2jemalloc_2server__session__impl_8hpp.html">ipc/session/detail/shm/arena_lend/jemalloc/server_session_impl.hpp</a>&quot;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2session_8hpp.html">ipc/session/shm/arena_lend/jemalloc/session.hpp</a>&quot;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__session_2src_2ipc_2session_2server__session_8hpp.html">ipc/session/server_session.hpp</a>&quot;</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#include &lt;boost/move/make_unique.hpp&gt;</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc.html">ipc::session::shm::arena_lend::jemalloc</a></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>{</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"></span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment">/**</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * Identical to session::Server_session in every way, except that it makes available two SHM arenas, from the</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * SHM-jemalloc provider (ipc::shm::arena_lend::jemalloc).  These SHM arenas (see #Arena doc header) have different</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * scopes:</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> *   - Per-session-scope, accessible via session_shm(): meaning it shall be accessible only during the lifetime of</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> *     this session, by this Session (via this accessor).</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> *     - Hence this arena is created at the time `*this` enters PEER state (near Session_server::async_accept()</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> *       successfully yielding `*this`).  When `*this` is destroyed or hosed, the arena is invalidated.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> *   - Per-app-scope, meaning its pool shall be accessible potentially beyond the lifetime of</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> *     this session but rather until the generating Session_server (i.e., server process) shuts down, by any</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> *     Session under that umbrella, now or in the future, as long as its Client_app equals that of `*this` session.</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> *     - Hence this arena is created at the time the shm::arena_lend::jemalloc::Session_server (emitter of `*this`</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> *       to user) first establishes a session with the *first* shm::arena_lend::jemalloc::Client_session matching</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> *       the same Client_app as `*this`.  I.e., it&#39;s created at the same time as `this-&gt;session_shm()` is, if</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> *       `*this` is the first such session; otherwise earlier.  When `*this` is destroyed or hosed (gracefully at</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> *       least), the arena is *not* invalidated but persists.</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> *</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * @note The opposing arena_lend::jemalloc::Client_session is similar but lacks the app_shm() #Arena.</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> *</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * ### Explicitly constructing an object in SHM; lending to opposing side ###</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * This setup is symmetrical w/r/t a given</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * shm::arena_lend::jemalloc::Server_session&lt;-&gt;shm::arena_lend::jemalloc::Client_session object pair.  Both</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> * can create new objects (via respective `Arena::construct()` methods).  Both can write and, of course, read</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * within locally `construct()`ed objects.  Lastly each can transmit any outer</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> * handle, returned by `construct()`, to the opposing side.  To do this</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> * call lend_object(), transmit the returned `Blob` to the opposing side via any desired IPC form (probably a</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> * transport::Channel or transport::struc::Channel), then recover a handle via borrow_object() on that opposing</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> * side.  As of this writing access to objects on the borrowing side is read-only, for safety reasons,</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> * but that could change (most likely becoming an optional mode) at the prerogative of ipc::shm::arena_lend</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> * developers.  (Do note that ipc::shm::classic allows full write access on the borrower side, as in an</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> * arena-sharing SHM-provider by definition both sides allocate and thus write to the same SHM pool(s).</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> * However this comes at the expense of safety.  Further discussion is up to ipc::shm docs.)</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> *</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> * @note Be ready for Session_mv::lend_object() to return an empty blob and Session_mv::borrow_object() to return</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> *       a null pointer, both indicating an error: the session is hosed (opposing process likely down).  See their</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> *       doc headers for a bit more info on this.</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> *</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> * By using `shm::stl::Arena_activator&lt;Arena&gt;` (alias shm::arena_lend::jemalloc::Ipc_arena_activator) and</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> * #Allocator (alias shm::arena_lend::jemalloc::Ipc_arena_allocator)</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> * it is possible to construct and transmit not just POD (Plain Old Datatype) objects but combinations of those</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> * with unlimited nested levels of STL-compliant containers.  On the borrowing side use</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> * #Borrower_allocator (no activator necessary).</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> *</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> * Detailed instructions can be found in those shm::stl and ipc::shm::arena_lend doc headers.</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> *</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> * ### Using SHM as backing memory for transport::struc::Channel ###</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> * Another use of session_shm() and app_shm() (though only on this session-server side in case of the latter) --</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> * in some ways perhaps superior -- is indirect.  The above technique involves manually constructing a</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> * C++ data structure and transmitting a short handle to it over IPC thus achieving high performance.</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> * It may be desirable, instead, to use a structured message, filled out according to schema.  This, of course,</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> * is why transport::struc::Channel exists.  As is explained in its docs, there is nothing SHM-centered about it.</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> * It does however have the key feature that allows one to supply, at compile-time, the builder and reader engines</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> * that acquire memory while the user mutates an out-message and later accesses it upon IPC-receipt.  Naturally one of</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> * the builder/reader pairs uses SHM, instead of regular heap, as the supplier of RAM.  Thus when</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> * one invokes transport::struc::Channel::send() and receives it in the opposing object, the actual bits</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> * copied into/out of the low-level transport are merely the SHM handle (and all of this is hidden from the user</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> * outside of the delightful near-zero-copy perf properties).</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> *</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> * There are two ways to make this happen.  The easiest and best way is, when constructing the</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> * `struc::Channel`, to use the alias session::shm::arena_lend::jemalloc::Session_mv::Structured_channel and</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> * create one via tag-form ctor with tag transport::struc::Channel_base::Serialize_via_session_shm</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> * (or `Serialize_via_app_shm`, server-side only).  Simply provide that tag and `this` (or, symmetrically,</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> * `shm::arena_lend::jemalloc::Client_session::this` on the other side).</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> *</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> * The harder way, albeit allowing for certain advanced setups, is to manually create a</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> * `transport::struc::shm::arena_lend::jemalloc::Builder::Config` and/or `Reader::Config`,</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> * passing in `this-&gt;session_shm()` and/or `this-&gt;app_shm()` and/or `this-&gt;session_shm()`, to those;</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> * and then pass the `Config` or `Config`s, plus `this-&gt;shm_session()`, to the non-tag-form of `struc::Channel`</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> * ctor.</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> *</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> * This is all documented on transport::struc::Channel.  Do realize, though, that those niceties are</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> * really built on this class template and/or the opposing shm::arena_lend::jemalloc::Client_session.</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> * To use them with ipc::session, you must thus choose shm::arena_lend::jemalloc::Server_session and</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> * shm::arena_lend::jemalloc::Client_session as your Session impls.</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> *</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> * ### Implementation ###</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> * It is probably not too difficult to understand how it works by just reading the code and doc headers.</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> * The key is that the core is still just what&#39;s supplied by a vanilla (non-SHM-aware) #Server_session.</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> * Ultimately all we need to add is some setup near the end of the vanilla session-opening procedure.</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> * This is easiest to discuss holistically, meaning both the server (`*this`) and client (opposing) side,</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> * so the discussion is all here.</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> *</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> * As with the vanilla session setup, remember that while in PEER state the APIs are identical/symmetrical,</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> * the roles of the server and client vary quite sharply internally -- especially before PEER state.</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> * The general outline is: Session_server listens for socket connections; a given</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> * `Client_session::sync_connect()` connects; at this stage Session_server constructs a not-yet-user-emitted</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> * #Server_session and invokes its `async_accept_log_in()`.  Now the #Client_session and #Server_session</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> * have established a channel (internal-use session master channel) and undergo the log-in exchange.</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> * #Client_session sends log-in request.  #Server_session verifies that, then replies with log-in response</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> * (including important bits of generated naming) and enters PEER state.  Once #Client_session (shortly) receives</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> * this response, it knows the session is ready to rock and also enters PEER state.  Voila.</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> *</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> * Where does SHM-jemalloc setup hook into this?  The simpler case is the session-client which manages only</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> * one #Arena (per-session scope: session_shm()), so let&#39;s describe it first.  In arena-lending SHM-providers,</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> * what it takes to construct and lend/borrow object in SHM is:</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> *   - An #Arena (managed in this process).  Things are constructed (allocated) by this.</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> *   - A #Shm_session (not to be confused with ipc::Session and company).  `Arena`-constructed objects are</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"> *     *lent* (`lend_object()`) via this object.  Opposing process&#39;s `Arena`-constructed objects are</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"> *     locally *borrowed* (`borrow_object()`) via this object.</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"> *   - The #Arena must be registered with the #Shm_session (`lend_arena()`) during setup.</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"> *</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"> * In some ways this is simpler than in SHM-classic, as in that one the arena is shared by the two processes, so</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment"> * one (we chose server) must create it and keep handle; while the other (client) must open it by a known name.</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment"> * In our case each side maintains its own arena, so the order does not matter per se.  There is however one</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"> * added complication:</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment"> *   - For the #Shm_session to be created, on either side, it must be passed a pre-opened `struc::Channel`</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> *     of a specific type which it shall use for internally-needed IPC.  Specifically it just wants a</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> *     transport::Socket_stream_channel_of_blobs which internally consists of a pre-connected local stream socket</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> *     (Unix domain socket).  Much as with user-requested channels in vanilla sessions, we assign the session-server</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> *     side the task of creating the socket-pair, sending one socket (transport::Native_handle) to client,</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> *     and expecting a quick ack message before proceeding to create #Shm_session.</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> *   - Accordingly the client side awaits the message (along session master channel) containing the socket,</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"> *     acks it, and creates the #Shm_session.</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"> *</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"> * To summarize, then, this is the flow for Client_session_impl::async_connect().</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> *   -# Vanilla session::Client_session_impl::async_connect() gets it to PEER state.  Cancel PEER state immediately</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"> *      in our substituted on-connect-done handler.</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"> *   -# Await the `Native_handle` to arrive on the session master channel (which was just used for vanilla</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"> *      session opening procedure and is now not being used).  Upon receipt send ack message and using the</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> *      received handle:</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> *   -# Create #Shm_session (Client_session_impl::shm_session() shall make it available).</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> *      - Session_impl::init_shm() does this.</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> *   -# Create per-session arena (Client_session_impl::session_shm() shall make it available).</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> *      - Session_impl::init_shm() does this.</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> *   -# Register the latter with the former.</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> *      - Session_impl::init_shm() does this.</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> *   -# Re-enter PEER state; and invoke the true (user-supplied) on-connect-done handler.</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> *</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> * If the server had symmetrical needs only, it&#39;d be easy to describe its algorithm -- basically mirror</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"> * the above.  However it also has the per-app arena (app_shm()).  It must be created, but only when an incoming</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"> * session-open request is the first for its Client_app.  (This logic is above the layer of sessions and must</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"> * reside in Session_server, not in Server_session_impl; but the two interact.)  Later, regardless of whether it</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> * was just created, app_shm() must be registered with the #Shm_session, once that is created.  Thus on the</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> * server side the async_accept_log_in() steps are:</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"> *   -# Vanilla async_accept_log_in() gets it to almost-PEER state.</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"> *      -# During the session::Session_server_impl &quot;per-Client_app setup&quot; customization-point hook:</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment"> *         Session_server: Create the per-app arena for that Client_app and save it in its app-to-arena map, unless</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"> *         it is already there (then do nothing).</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"> *      -# During the session::Server_session_impl `pre_rsp_setup_func` hook that executes shortly after that:</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"> *         Cache the appropraite Session_server::app_shm() inside `*this` Server_session_impl, for quick</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> *         subsequent access via Server_session::app_shm().</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> *   -# Before invoking the user&#39;s on-accept-done handler -- giving them their new `Server_session` --</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment"> *      perform the following *synchronous* steps:</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"> *      -# Create the pre-connected native-handle pair (socket-pair).</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment"> *      -# Synchronously send it via session master channel (which was just used for vanilla session opening</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> *         procedure and is now not being used) and get ack from client (see above).</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> *   -# Create #Shm_session (Client_session_impl::shm_session() shall make it available).</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> *      - Session_impl::init_shm() does this.</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> *   -# Create per-session arena (Client_session_impl::session_shm() shall make it available).</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> *      - Session_impl::init_shm() does this.</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> *   -# Register the latter with the former.</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"> *      - Session_impl::init_shm() does this.</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment"> *   -# Register app_shm() (cached a few steps earlier) with the former (#Shm_session) also.</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment"> *      - Session_impl::init_shm() does this.</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"> *   -# Invoke the true (user-supplied) on-accept-done handler.</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment"> *</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment"> * The last and most boring piece of the puzzle are the pImpl-lite wrappers around the SHM-specific API</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment"> * that shm::arena_lend::jemalloc::Server_session adds to super-class Server_session_mv: `session_shm()` and so on.</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment"> * Because this API is (with the exception of app_shm() (and buddies) being server-only) exactly identical for</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment"> * both shm::arena_lend::jemalloc::Server_session and shm::arena_lend::jemalloc::Client_session,</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment"> * to avoid torturous copy/pasting these common wrappers are collected in shm::arena_lend::jemalloc::Session_mv</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment"> * which we sub-class.  So the `public` API is distributed as follows from bottom to top:</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment"> *   - shm::arena_lend::jemalloc::Server_session</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment"> *     =&gt; shm::arena_lend::jemalloc::Session_mv =&gt; session::Server_session_mv =&gt; session::Session_mv</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment"> *     =&gt; shm::arena_lend::jemalloc::Server_session_impl</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment"> *   - shm::arena_lend::jemalloc::Client_session</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment"> *     == shm::arena_lend::jemalloc::Session_mv =&gt; session::Client_session_mv =&gt; session::Session_mv</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment"> *     =&gt; shm::arena_lend::jemalloc::Client_session_impl</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment"> *     - The bottom two in this case are not even inherited but one aliases to the other.  This is because</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment"> *       there&#39;s nothing added API-wise on the client side.  On the server side, as you see below, at least</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment"> *       app_shm() is necessary to add, so we can&#39;t alias and must sub-class.</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment"> *</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment"> * You&#39;ll notice, like, `Base::Base::Base::Impl` and `Base::Base::Base::Impl()` in certain code below;</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment"> * that&#39;s navigating the above hierarchy.</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment"> *</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span><span class="comment"> * @endinternal</span></div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment"> *</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment"> * @tparam S_MQ_TYPE_OR_NONE</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment"> *         Identical to session::Server_session.</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment"> * @tparam S_TRANSMIT_NATIVE_HANDLES</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment"> *         Identical to session::Server_session.</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment"> * @tparam Mdt_payload</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment"> *         Identical to session::Server_session.</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment"> */</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="keyword">template</span>&lt;session::schema::MqType S_MQ_TYPE_OR_NONE, <span class="keywordtype">bool</span> S_TRANSMIT_NATIVE_HANDLES, <span class="keyword">typename</span> Mdt_payload&gt;</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html">  226</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html">Server_session</a> : <span class="keyword">public</span> <a class="code hl_class" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Session__mv.html">Session_mv</a></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span>                                &lt;session::Server_session_mv</div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span>                                   &lt;Server_session_impl&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;&gt;&gt;</div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span>{</div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment"></span> </div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment">  /// Short-hand for our base class.  To the user: note its `public` API is inherited.</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#aee0d5c20c166905ba0d915e182cb7e13">  234</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Session__mv.html">Base</a> = <a class="code hl_class" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Session__mv.html">Session_mv</a></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span>                 &lt;<a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">session::Server_session_mv</a></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span>                    &lt;<a class="code hl_class" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session__impl.html">Server_session_impl&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;</a>&gt;&gt;;</div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment"></span> </div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment">  /// Short-hand for base class member alias Session_mv::Arena.  Its doc header contains useful context and tips.</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a988281add5dc4a31202cfba47f458e5a">  239</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a988281add5dc4a31202cfba47f458e5a">Arena</a> = <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Session__mv.html#ae30ae4b65cd4178fa26eed660688829f">Base::Arena</a>;</div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment"></span> </div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment">  /// Short-hand for base class member alias Session_mv::Structured_msg_builder_config.</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a7de5ec3e9331c46664a493e060edb6f6">  242</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a7de5ec3e9331c46664a493e060edb6f6">Structured_msg_builder_config</a> = <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1session_1_1Session__mv.html#a9f6e9a57f6e6ab420d554a2c0eba7877">Base::Structured_msg_builder_config</a>;</div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span> </div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment"></span> </div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment">  /// Inherit default, move ctors.</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">Base::Base</a>;</div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span> </div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment"></span> </div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment">   * Returns SHM #Arena with per-app scope, meaning its pool shall be accessible potentially beyond the lifetime of</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment">   * this session but rather until the generating Session_server (i.e., server process) shuts down, by any</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment">   * Session under that umbrella, now or in the future, as long as its Client_app equals that of `*this` session.</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment">   *</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">   * @note A similar #Arena is *not* available in the opposing #Client_session.</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment">   *</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">   * See #Arena doc header for useful instructions on working with #Arena, lend_object(), and borrow_object().</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment">   *</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment">   */</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span>  <a class="code hl_typedef" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a988281add5dc4a31202cfba47f458e5a">Arena</a>* <a class="code hl_function" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a20d4838f6ff705bd2ad33de066ae2d4d">app_shm</a>();</div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment"></span> </div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment">   * Identical to app_shm() but returns that via a `shared_ptr`-handle as required for work directly within</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment">   * ipc::shm::arena_lend::jemalloc APIs.  Note this is a quirk of that particular API and, in particular, has</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment">   * no equivalent in ipc::session::shm::classic `Session` and `Session_server` counterparts.</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment">   * It should not be necessary to use except when going beyond ipc::session for your SHM-arena needs.</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment">   *</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment">   */</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span>  std::shared_ptr&lt;Arena&gt; <a class="code hl_function" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a841ce582dbb9084c7dc934f0d2fbb757">app_shm_ptr</a>();</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span><span class="comment"></span> </div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment">   * Returns builder config suitable for capnp-serializing out-messages in SHM arena app_shm().</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment">   *</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span><span class="comment">   */</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span>  <a class="code hl_typedef" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a7de5ec3e9331c46664a493e060edb6f6">Structured_msg_builder_config</a> <a class="code hl_function" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a26c1d34c7be1002cc9fc8ae9eeae8164">app_shm_builder_config</a>();</div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span><span class="comment"></span> </div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">   * When transmitting items originating in #Arena app_shm() via transport::struc::shm::Builder::emit_serialization()</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment">   * (and/or transport::struc::Channel send facilities), returns additional-to-payload information necessary to</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment">   * target the opposing process properly.</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment">   *</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment">   * Internally: Since `*this` type is based on arena-lending SHM-provider type, this is simply shm_session().</span></div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="comment">   * Generic code of yours should not need to rely on that impl detail, but we mention it for education/context.</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment">   *</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment">   */</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span>  <span class="keyword">typename</span> Structured_msg_builder_config::Builder::Session <a class="code hl_function" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#af9ce191cc25d67c6c098ea56849ef2d5">app_shm_lender_session</a>();</div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span> </div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span>  <span class="comment">// Constructors.</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment"></span> </div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment">   * For use by internal user Session_server_impl: constructor.  Identical to Server_session_mv ctor.</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment">   *</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment">   *        See Server_session_mv ctor.</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment">   * @param srv_app_ref</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment">   *        See Server_session_mv ctor.</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment">   * @param master_channel_sock_stm</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment">   *        See Server_session_mv ctor.</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment">   */</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a3a407e1a87e5b384c3903ede62cca650">Server_session</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref,</div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span>                          <a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream.html">transport::Native_socket_stream</a>&amp;&amp; master_channel_sock_stm);</div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span>}; <span class="comment">// class Server_session</span></div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span> </div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span> </div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment"></span> </div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno"><a class="line" href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp.html#a19315836a0055d73f3f1b43ddec1a207">  315</a></span><span class="comment"></span><span class="preprocessor">#define TEMPLATE_JEM_SRV_SESSION \</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="preprocessor">  template&lt;session::schema::MqType S_MQ_TYPE_OR_NONE, bool S_TRANSMIT_NATIVE_HANDLES, \</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="preprocessor">           typename Mdt_payload&gt;</span><span class="comment"></span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno"><a class="line" href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp.html#a91c9b4202f38c2f93a653c68836e67b1">  319</a></span><span class="comment"></span><span class="preprocessor">#define CLASS_JEM_SRV_SESSION \</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="preprocessor">  Server_session&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span> </div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><a class="code hl_define" href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp.html#a19315836a0055d73f3f1b43ddec1a207">TEMPLATE_JEM_SRV_SESSION</a></div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a3a407e1a87e5b384c3903ede62cca650">  323</a></span><a class="code hl_typedef" href="namespaceipc_1_1session.html#ab01d5bce0ab2f3435ca9dd88d27609dc">CLASS_JEM_SRV_SESSION::Server_session</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref_arg,</div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span>                                       <a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream.html">transport::Native_socket_stream</a>&amp;&amp; master_channel_sock_stm)</div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span>{</div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span>  Base::Base::Base::impl() = boost::movelib::make_unique&lt;typename Base::Base::Base::Impl&gt;</div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span>                               (logger_ptr, srv_app_ref_arg, std::move(master_channel_sock_stm));</div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span>}</div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span> </div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment">// The rest just continues the pImpl-lite paradigm, same as our public super-class.</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span> </div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><a class="code hl_define" href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp.html#a19315836a0055d73f3f1b43ddec1a207">TEMPLATE_JEM_SRV_SESSION</a></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a20d4838f6ff705bd2ad33de066ae2d4d">  333</a></span><span class="keyword">typename</span> CLASS_JEM_SRV_SESSION::Arena* CLASS_JEM_SRV_SESSION::app_shm()</div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span>{</div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span>  assert(Base::Base::Base::impl() &amp;&amp; <span class="stringliteral">&quot;Do not call this on as-if-default-cted Session.&quot;</span>);</div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span>  <span class="keywordflow">return</span> Base::Base::Base::impl()-&gt;app_shm();</div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span>}</div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span> </div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span><a class="code hl_define" href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp.html#a19315836a0055d73f3f1b43ddec1a207">TEMPLATE_JEM_SRV_SESSION</a></div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a841ce582dbb9084c7dc934f0d2fbb757">  340</a></span>std::shared_ptr&lt;typename CLASS_JEM_SRV_SESSION::Arena&gt; CLASS_JEM_SRV_SESSION::app_shm_ptr()</div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span>{</div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span>  assert(Base::Base::Base::impl() &amp;&amp; <span class="stringliteral">&quot;Do not call this on as-if-default-cted Session.&quot;</span>);</div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span>  <span class="keywordflow">return</span> Base::Base::Base::impl()-&gt;app_shm_ptr();</div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span>}</div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span> </div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><a class="code hl_define" href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp.html#a19315836a0055d73f3f1b43ddec1a207">TEMPLATE_JEM_SRV_SESSION</a></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="keyword">typename</span> CLASS_JEM_SRV_SESSION::Structured_msg_builder_config</div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a26c1d34c7be1002cc9fc8ae9eeae8164">  348</a></span>  CLASS_JEM_SRV_SESSION::app_shm_builder_config()</div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span>{</div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span>  assert(Base::Base::Base::impl() &amp;&amp; <span class="stringliteral">&quot;Do not call this on as-if-default-cted Session.&quot;</span>);</div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span>  <span class="keywordflow">return</span> Base::Base::Base::impl()-&gt;app_shm_builder_config();</div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span>}</div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span> </div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><a class="code hl_define" href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp.html#a19315836a0055d73f3f1b43ddec1a207">TEMPLATE_JEM_SRV_SESSION</a></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="keyword">typename</span> CLASS_JEM_SRV_SESSION::Structured_msg_builder_config::Builder::Session</div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#af9ce191cc25d67c6c098ea56849ef2d5">  356</a></span>  CLASS_JEM_SRV_SESSION::app_shm_lender_session()</div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span>{</div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span>  assert(Base::Base::Base::impl() &amp;&amp; <span class="stringliteral">&quot;Do not call this on as-if-default-cted Session.&quot;</span>);</div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span>  <span class="keywordflow">return</span> Base::Base::Base::impl()-&gt;app_shm_lender_session();</div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span>}</div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span> </div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><a class="code hl_define" href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp.html#a19315836a0055d73f3f1b43ddec1a207">TEMPLATE_JEM_SRV_SESSION</a></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a8fc81db9a5adc7b6efc8529b5f1d98d2">  363</a></span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc.html#a5044ac385b12210816fc95ca1d5408b6">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_define" href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp.html#a91c9b4202f38c2f93a653c68836e67b1">CLASS_JEM_SRV_SESSION</a>&amp; val)</div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span>{</div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span>  <span class="keywordflow">return</span> os &lt;&lt; static_cast&lt;const typename CLASS_JEM_SRV_SESSION::Base&amp;&gt;(val);</div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span>}</div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span> </div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span><span class="preprocessor">#undef CLASS_JEM_SRV_SESSION</span></div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="preprocessor">#undef TEMPLATE_JEM_SRV_SESSION</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span> </div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span>} <span class="comment">// namespace ipc::session::shm::arena_lend::jemalloc</span></div>
<div class="ttc" id="aclassipc_1_1session_1_1Server__session__mv_html"><div class="ttname"><a href="classipc_1_1session_1_1Server__session__mv.html">ipc::session::Server_session_mv</a></div><div class="ttdoc">Implements Session concept on the Server_app end: a Session that is emitted in almost-PEER state by l...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2server__session_8hpp_source.html#l00122">server_session.hpp:124</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__mv_html_a9f6e9a57f6e6ab420d554a2c0eba7877"><div class="ttname"><a href="classipc_1_1session_1_1Session__mv.html#a9f6e9a57f6e6ab420d554a2c0eba7877">ipc::session::Session_mv&lt; Server_session_impl&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload &gt; &gt;::Structured_msg_builder_config</a></div><div class="ttdeci">typename Impl::Structured_msg_builder_config Structured_msg_builder_config</div><div class="ttdoc">Implements Session API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session_8hpp_source.html#l00573">session.hpp:573</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session__impl_html"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session__impl.html">ipc::session::shm::arena_lend::jemalloc::Server_session_impl</a></div><div class="ttdoc">Core internally-used implementation of shm::arena_lend::jemalloc::Server_session: it is to the latter...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2detail_2shm_2arena__lend_2jemalloc_2server__session__impl_8hpp_source.html#l00053">server_session_impl.hpp:60</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session_html"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html">ipc::session::shm::arena_lend::jemalloc::Server_session</a></div><div class="ttdoc">Identical to session::Server_session in every way, except that it makes available two SHM arenas,...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp_source.html#l00226">server_session.hpp:229</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session_html_a20d4838f6ff705bd2ad33de066ae2d4d"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a20d4838f6ff705bd2ad33de066ae2d4d">ipc::session::shm::arena_lend::jemalloc::Server_session::app_shm</a></div><div class="ttdeci">Arena * app_shm()</div><div class="ttdoc">Returns SHM Arena with per-app scope, meaning its pool shall be accessible potentially beyond the lif...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp_source.html#l00333">server_session.hpp:333</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session_html_a26c1d34c7be1002cc9fc8ae9eeae8164"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a26c1d34c7be1002cc9fc8ae9eeae8164">ipc::session::shm::arena_lend::jemalloc::Server_session::app_shm_builder_config</a></div><div class="ttdeci">Structured_msg_builder_config app_shm_builder_config()</div><div class="ttdoc">Returns builder config suitable for capnp-serializing out-messages in SHM arena app_shm().</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp_source.html#l00348">server_session.hpp:348</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session_html_a3a407e1a87e5b384c3903ede62cca650"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a3a407e1a87e5b384c3903ede62cca650">ipc::session::shm::arena_lend::jemalloc::Server_session::Server_session</a></div><div class="ttdeci">Server_session(flow::log::Logger *logger_ptr, const Server_app &amp;srv_app_ref, transport::Native_socket_stream &amp;&amp;master_channel_sock_stm)</div><div class="ttdoc">For use by internal user Session_server_impl: constructor.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp_source.html#l00323">server_session.hpp:323</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session_html_a7de5ec3e9331c46664a493e060edb6f6"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a7de5ec3e9331c46664a493e060edb6f6">ipc::session::shm::arena_lend::jemalloc::Server_session::Structured_msg_builder_config</a></div><div class="ttdeci">typename Base::Structured_msg_builder_config Structured_msg_builder_config</div><div class="ttdoc">Short-hand for base class member alias Session_mv::Structured_msg_builder_config.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp_source.html#l00242">server_session.hpp:242</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session_html_a841ce582dbb9084c7dc934f0d2fbb757"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a841ce582dbb9084c7dc934f0d2fbb757">ipc::session::shm::arena_lend::jemalloc::Server_session::app_shm_ptr</a></div><div class="ttdeci">std::shared_ptr&lt; Arena &gt; app_shm_ptr()</div><div class="ttdoc">Identical to app_shm() but returns that via a shared_ptr-handle as required for work directly within ...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp_source.html#l00340">server_session.hpp:340</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session_html_a988281add5dc4a31202cfba47f458e5a"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#a988281add5dc4a31202cfba47f458e5a">ipc::session::shm::arena_lend::jemalloc::Server_session::Arena</a></div><div class="ttdeci">typename Base::Arena Arena</div><div class="ttdoc">Short-hand for base class member alias Session_mv::Arena. Its doc header contains useful context and ...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp_source.html#l00239">server_session.hpp:239</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session_html_af9ce191cc25d67c6c098ea56849ef2d5"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Server__session.html#af9ce191cc25d67c6c098ea56849ef2d5">ipc::session::shm::arena_lend::jemalloc::Server_session::app_shm_lender_session</a></div><div class="ttdeci">Structured_msg_builder_config::Builder::Session app_shm_lender_session()</div><div class="ttdoc">When transmitting items originating in Arena app_shm() via transport::struc::shm::Builder::emit_seria...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp_source.html#l00356">server_session.hpp:356</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Session__mv_html"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Session__mv.html">ipc::session::shm::arena_lend::jemalloc::Session_mv</a></div><div class="ttdoc">Implements the SHM-related API common to shm::arena_lend::jemalloc::Server_session and shm::arena_len...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2session_8hpp_source.html#l00050">session.hpp:52</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Session__mv_html_ae30ae4b65cd4178fa26eed660688829f"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_1_1Session__mv.html#ae30ae4b65cd4178fa26eed660688829f">ipc::session::shm::arena_lend::jemalloc::Session_mv&lt; session::Server_session_mv&lt; Server_session_impl&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload &gt; &gt; &gt;::Arena</a></div><div class="ttdeci">typename Base::Base::Impl::Arena Arena</div><div class="ttdoc">The arena object on which one may call construct&lt;T&gt;(ctor_args...), where ctor_args are arguments to t...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2session_8hpp_source.html#l00093">session.hpp:93</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html">ipc::transport::Native_socket_stream</a></div><div class="ttdoc">Implements both Native_handle_sender and Native_handle_receiver concepts by using a stream-oriented U...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8hpp_source.html#l00270">native_socket_stream.hpp:271</a></div></div>
<div class="ttc" id="aipc__session_2src_2ipc_2session_2server__session_8hpp_html"><div class="ttname"><a href="ipc__session_2src_2ipc_2session_2server__session_8hpp.html">server_session.hpp</a></div></div>
<div class="ttc" id="aipc__shm__arena__lend_2src_2ipc_2session_2detail_2shm_2arena__lend_2jemalloc_2server__session__impl_8hpp_html"><div class="ttname"><a href="ipc__shm__arena__lend_2src_2ipc_2session_2detail_2shm_2arena__lend_2jemalloc_2server__session__impl_8hpp.html">server_session_impl.hpp</a></div></div>
<div class="ttc" id="aipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp_html_a19315836a0055d73f3f1b43ddec1a207"><div class="ttname"><a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp.html#a19315836a0055d73f3f1b43ddec1a207">TEMPLATE_JEM_SRV_SESSION</a></div><div class="ttdeci">#define TEMPLATE_JEM_SRV_SESSION</div><div class="ttdoc">Internally used macro; public API users should disregard (same deal as in struc/channel....</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp_source.html#l00315">server_session.hpp:315</a></div></div>
<div class="ttc" id="aipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp_html_a91c9b4202f38c2f93a653c68836e67b1"><div class="ttname"><a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp.html#a91c9b4202f38c2f93a653c68836e67b1">CLASS_JEM_SRV_SESSION</a></div><div class="ttdeci">#define CLASS_JEM_SRV_SESSION</div><div class="ttdoc">Internally used macro; public API users should disregard (same deal as in struc/channel....</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2server__session_8hpp_source.html#l00319">server_session.hpp:319</a></div></div>
<div class="ttc" id="aipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2session_8hpp_html"><div class="ttname"><a href="ipc__shm__arena__lend_2src_2ipc_2session_2shm_2arena__lend_2jemalloc_2session_8hpp.html">session.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_html"><div class="ttname"><a href="namespaceipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc.html">ipc::session::shm::arena_lend::jemalloc</a></div><div class="ttdoc">Support for SHM-backed ipc::session sessions and session-servers with the SHM-jemalloc (ipc::shm::are...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2detail_2shm_2arena__lend_2jemalloc_2client__session__impl_8hpp_source.html#l00034">client_session_impl.hpp:35</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc_html_a5044ac385b12210816fc95ca1d5408b6"><div class="ttname"><a href="namespaceipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc.html#a5044ac385b12210816fc95ca1d5408b6">ipc::session::shm::arena_lend::jemalloc::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Client_session_impl&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload &gt; &amp;val)</div><div class="ttdoc">Prints string representation of the given Client_session_impl to the given ostream.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm__arena__lend_2src_2ipc_2session_2detail_2shm_2arena__lend_2jemalloc_2client__session__impl_8hpp_source.html#l00592">client_session_impl.hpp:592</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_ab01d5bce0ab2f3435ca9dd88d27609dc"><div class="ttname"><a href="namespaceipc_1_1session.html#ab01d5bce0ab2f3435ca9dd88d27609dc">ipc::session::Server_session</a></div><div class="ttdeci">Server_session_mv&lt; Server_session_impl&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload &gt; &gt; Server_session</div><div class="ttdoc">A vanilla Server_session with no optional capabilities.</div><div class="ttdef"><b>Definition:</b> <a href="session__fwd_8hpp_source.html#l00288">session_fwd.hpp:289</a></div></div>
<div class="ttc" id="asession_2shm_2arena__lend_2jemalloc_2jemalloc_8hpp_html"><div class="ttname"><a href="session_2shm_2arena__lend_2jemalloc_2jemalloc_8hpp.html">jemalloc.hpp</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Server__app_html"><div class="ttname"><a href="structipc_1_1session_1_1Server__app.html">ipc::session::Server_app</a></div><div class="ttdoc">An App that is used as a server in at least one client-server IPC split.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00205">app.hpp:206</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
